// 
// Entify project
//  
// Author:
//       Lauri Taimila <lauri@taimila.com>
// 
// Copyright (c) 2010 Lauri Taimila
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

using System;
using System.Collections.Generic;

namespace Taimila.Entify
{
	/// <summary>
	/// Sort filter can be used to sort results of the EntityRequest.
	/// </summary>
	public sealed class SortFilter
	{
		/// <summary>
		/// Create a new SortFilter with a list of property names. Sorting
		/// is done in the order of given propeties. So the result is first
		/// sorted with the first parameter, then with the second parameter etc.
		/// 
		/// Default sort direction is ascending.
		/// </summary>
		/// <param name="properties">
		/// List of property names. <see cref="System.String[]"/>
		/// </param>
		public SortFilter (params string[] properties)
		{
			this.Properties = new List<string>();
			this.Properties.AddRange(properties);
			this.Direction = SortDirection.Ascending;
		}
		
		/// <summary>
		/// Create a new SortFilter with a list of property names. Sorting
		/// is done in the order of given propeties. So the result is first
		/// sorted with the first parameter, then with the second parameter etc.
		/// </summary>
		/// <param name="direction">
		/// Ascending or descending sort direction. <see cref="SortDirection"/>
		/// </param>
		/// <param name="properties">
		/// List of property names. <see cref="System.String[]"/>
		/// </param>
		public SortFilter (SortDirection direction, params string[] properties) : this(properties)
		{
			this.Direction = direction;
		}
		
		/// <summary>
		/// List of property names.
		/// </summary>
		public List<string> Properties
		{
			get;
			set;
		}
		
		/// <summary>
		/// Defines sort direction.
		/// </summary>
		public SortDirection Direction
		{
			get;
			set;
		}
	}
	
	/// <summary>
	/// Enumerates sort directions.
	/// </summary>
	public enum SortDirection
	{
		/// <summary>
		/// Ascending order.
		/// </summary>
		Ascending,
		
		/// <summary>
		/// Descending order.
		/// </summary>
		Descending
	}
}
